Azure Maps Render Service (preview:2.1)

2025/10/14 • 3 updated methods

RenderV2_GetMapTile (updated)
Description :  The `Get Map Tiles` API enables users to request map tiles in either vector or raster formats, typically for integration into a map control or SDK. Supported tile types include Azure Maps road tiles and real-time Weather Radar tiles. By default, the Azure Maps [Web SDK](/azure/azure-maps/about-azure-maps#web-sdk) uses vector tiles for rendering its web map control.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RenderV2_GetMapTile",
  "Description": {
    "new": "The `Get Map Tiles` API enables users to request map tiles in either vector or raster formats, typically for integration into a map control or SDK. Supported tile types include Azure Maps road tiles and real-time Weather Radar tiles. By default, the Azure Maps [Web SDK](/azure/azure-maps/about-azure-maps#web-sdk) uses vector tiles for rendering its web map control.",
    "old": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Get Map Tiles API allows users to request map tiles in vector or raster formats typically to be integrated  into a map control or SDK. Some example tiles that can be requested are Azure Maps road tiles, real-time  Weather Radar tiles or the map tiles created using [Azure Maps Creator](https://aka.ms/amcreator). By default,  Azure Maps uses vector tiles for its web map control (Web SDK) and Android SDK."
  },
  "$parameters": [
    {
      "#name": "tilesetId",
      "Description": {
        "new": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.",
        "old": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset  zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the  [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied  by Azure Maps are listed below. For example, microsoft.base."
      }
    }
  ]
}

⚼ Request

GET:  /map/tile
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.1 ,
Required: True ,
}
string ,
tilesetId:
{
Description: A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. ,
Required: True ,
}
string ,
zoom:
{
Description: Zoom level for the desired tile. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
x:
{
Description: X coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1]. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
y:
{
Description: Y coordinate of the tile on zoom grid. Value must be in the range [0, 2`zoom` -1]. Please see [Zoom Levels and Tile Grid](https://docs.microsoft.com/azure/location-based-services/zoom-levels-and-tile-grid) for details. ,
Format: int32 ,
Required: True ,
}
integer ,
timeStamp:
{
Description: The desired date and time of the requested tile. This parameter must be specified in the standard date-time format (e.g. 2019-11-14T16:03:00-08:00), as defined by [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). This parameter is only supported when tilesetId parameter is set to one of the values below. * microsoft.weather.infrared.main: We provide tiles up to 3 hours in the past. Tiles are available in 10-minute intervals. We round the timeStamp value to the nearest 10-minute time frame. * microsoft.weather.radar.main: We provide tiles up to 1.5 hours in the past and up to 2 hours in the future. Tiles are available in 5-minute intervals. We round the timeStamp value to the nearest 5-minute time frame. ,
Format: date-time ,
Required: False ,
}
string ,
tileSize:
{
Description: The size of the returned map tile in pixels. ,
Required: False ,
}
string ,
language:
{
Description: Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to [Supported Languages](https://docs.microsoft.com/azure/azure-maps/supported-languages) for details. ,
Required: False ,
}
string ,
view:
{
Description: The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
content-type:
{
Description: The content-type for the response. ,
}
string ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RenderV2_GetMapTileset (updated)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Get Map Tileset API allows users to request metadata for a tileset.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RenderV2_GetMapTileset",
  "$parameters": [
    {
      "#name": "tilesetId",
      "Description": {
        "new": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.",
        "old": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset  zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the  [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied  by Azure Maps are listed below. For example, microsoft.base."
      }
    }
  ]
}

⚼ Request

GET:  /map/tileset
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.1 ,
Required: True ,
}
string ,
tilesetId:
{
Description: A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tilejson:
{
Description: Describes the version of the TileJSON spec that is implemented by this JSON object. ,
Required: False ,
}
string ,
name:
{
Description: A name describing the tileset. The name can contain any legal character. Implementations SHOULD NOT interpret the name as HTML. ,
Required: False ,
}
string ,
description:
{
Description: Text description of the tileset. The description can contain any legal character. Implementations SHOULD NOT interpret the description as HTML. ,
Required: False ,
}
string ,
version:
{
Description: A semver.org style version number for the tiles contained within the tileset. When changes across tiles are introduced, the minor version MUST change. ,
Required: False ,
}
string ,
attribution:
{
Description: Copyright attribution to be displayed on the map. Implementations MAY decide to treat this as HTML or literal text. For security reasons, make absolutely sure that this field can't be abused as a vector for XSS or beacon tracking. ,
Required: False ,
}
string ,
template:
{
Description: A mustache template to be used to format data from grids for interaction. ,
Required: False ,
}
string ,
legend:
{
Description: A legend to be displayed with the map. Implementations MAY decide to treat this as HTML or literal text. For security reasons, make absolutely sure that this field can't be abused as a vector for XSS or beacon tracking. ,
Required: False ,
}
string ,
scheme:
{
Description: Default: "xyz". Either "xyz" or "tms". Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed. ,
Required: False ,
}
string ,
tiles:
{
Description: An array of tile endpoints. If multiple endpoints are specified, clients may use any combination of endpoints. All endpoints MUST return the same content for the same URL. The array MUST contain at least one endpoint. ,
Required: False ,
}
[
string ,
]
,
grids:
{
Description: An array of interactivity endpoints. ,
Required: False ,
}
[
string ,
]
,
data:
{
Description: An array of data files in GeoJSON format. ,
Required: False ,
}
[
string ,
]
,
minzoom:
{
Description: The minimum zoom level. ,
Required: False ,
}
integer ,
maxzoom:
{
Description: The maximum zoom level. ,
Required: False ,
}
integer ,
bounds:
{
Description: The maximum extent of available map tiles. Bounds MUST define an area covered by all zoom levels. The bounds are represented in WGS:84 latitude and longitude values, in the order left, bottom, right, top. Values may be integers or floating point numbers. ,
Required: False ,
}
[
number ,
]
,
center:
{
Description: The default location of the tileset in the form [longitude, latitude, zoom]. The zoom level MUST be between minzoom and maxzoom. Implementations can use this value to set the default location. ,
Required: False ,
}
[
number ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RenderV2_GetMapAttribution (updated)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Get Map Attribution API allows users to request map copyright attribution information for a section of a tileset.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RenderV2_GetMapAttribution",
  "$parameters": [
    {
      "#name": "tilesetId",
      "Description": {
        "new": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base.",
        "old": "A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset  zoom levels. Every tileset has a **tilesetId** to use when making requests. The **tilesetId** for tilesets created using [Azure Maps Creator](https://aka.ms/amcreator) are generated through the  [Tileset Create API](https://docs.microsoft.com/rest/api/maps-creator/tileset). The ready-to-use tilesets supplied  by Azure Maps are listed below. For example, microsoft.base."
      }
    }
  ]
}

⚼ Request

GET:  /map/attribution
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. Current version is 2.1 ,
Required: True ,
}
string ,
tilesetId:
{
Description: A tileset is a collection of raster or vector data broken up into a uniform grid of square tiles at preset zoom levels. Every tileset has a **tilesetId** to use when making requests. The ready-to-use tilesets supplied by Azure Maps are listed below. For example, microsoft.base. ,
Required: True ,
}
string ,
zoom:
{
Description: Zoom level for the desired map attribution. ,
Format: int32 ,
Required: True ,
}
integer ,
bounds:
{
Description: The string that represents the rectangular area of a bounding box. The bounds parameter is defined by the 4 bounding box coordinates, with WGS84 longitude and latitude of the southwest corner followed by WGS84 longitude and latitude of the northeast corner. The string is presented in the following format: `[SouthwestCorner_Longitude, SouthwestCorner_Latitude, NortheastCorner_Longitude, NortheastCorner_Latitude]`. ,
Required: True ,
}
array ,
}

⚐ Response (200)

{
copyrights:
{
Description: A list of copyright strings. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}